@types/query-string

What is @types/query-string?

@types/query-string provides TypeScript type definitions for the query-string library, which is used to parse and stringify URL query strings.

What are @types/query-string's main functionalities?

Parse a query string

This feature allows you to parse a query string into an object. The example demonstrates parsing a query string with multiple parameters, including repeated keys.

const queryString = require('query-string');
const parsed = queryString.parse('?foo=bar&abc=xyz&abc=123');
console.log(parsed); // { foo: 'bar', abc: ['xyz', '123'] }

Stringify an object into a query string

This feature allows you to convert an object into a query string. The example shows how an object with multiple parameters, including arrays, is stringified.

const queryString = require('query-string');
const stringified = queryString.stringify({ foo: 'bar', abc: ['xyz', '123'] });
console.log(stringified); // 'foo=bar&abc=xyz&abc=123'

Parse a query string with nested objects

This feature allows you to parse query strings that contain nested objects. The example demonstrates parsing a query string with a nested object.

const queryString = require('query-string');
const parsed = queryString.parse('?foo[bar]=baz');
console.log(parsed); // { foo: { bar: 'baz' } }

Stringify an object with nested objects

This feature allows you to convert an object with nested objects into a query string. The example shows how a nested object is stringified.

const queryString = require('query-string');
const stringified = queryString.stringify({ foo: { bar: 'baz' } });
console.log(stringified); // 'foo[bar]=baz'

Other packages similar to @types/query-string

qs

The 'qs' package is another popular library for parsing and stringifying query strings. It offers more advanced features and customization options compared to query-string, such as handling nested objects and arrays more gracefully.

url-search-params

The 'url-search-params' package is a polyfill for the URLSearchParams interface, which is a native JavaScript API for working with query strings. It provides a more modern and standardized approach compared to query-string.

querystring

The 'querystring' module is a core Node.js module for parsing and formatting URL query strings. It is more basic and less feature-rich compared to query-string, but it is built into Node.js and does not require an additional dependency.

README

This is a stub types definition for query-string (https://github.com/sindresorhus/query-string).

query-string provides its own type definitions, so you don't need @types/query-string installed!